Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget/TextlessActionWidget

TextlessActionWidget

open class TextlessActionWidget(activeIcon: Identifier, inactiveIcon: Identifier, highlightedIcon: Identifier, activeNarration: Text, inactiveNarration: Text, activeSupplier: Supplier<Boolean>, pressAction: Consumer<TextlessActionWidget>, renderBackground: Boolean) : CustomPressableWidget

A button widget that is 20x20 pixels and displays a sprite instead of a textual message

Author

fzzyhmstrs

Since

0.2.0, added optional bg rendering 0.6.0

Parameters

activeIcon

Identifier - sprite id for active-but-not-hovered state

inactiveIcon

Identifier - sprite id for inactive/disabled state, controlled via activeSupplier

highlightedIcon

Identifier - sprite id for the active-and-hovered state

activeNarration

Text - the tooltip and narration for active states

inactiveNarration

Text - narration and tooltip to display if the button is inactive

activeSupplier

Supplier - supplies whether this widget should be active

pressAction

Consumer - action to take on press

renderBackground

Default false. If true, will render a standard MC button background behind your icon.

Inheritors

ConfigScreenWidget

Constructors

TextlessActionWidget

constructor(activeIcon: Identifier, inactiveIcon: Identifier, highlightedIcon: Identifier, activeNarration: Text, inactiveNarration: Text, activeSupplier: Supplier<Boolean>, pressAction: Consumer<TextlessActionWidget>)

constructor(icon: Identifier, activeNarration: Text, inactiveNarration: Text, activeSupplier: Supplier<Boolean>, pressAction: Consumer<TextlessActionWidget>)

Properties

var active: Boolean

var focused: Boolean

var message: Text

var navigationOrder: Int

visible

var visible: Boolean

var x: Int

var y: Int

Functions

appendNarrations

override fun appendNarrations(builder: NarrationMessageBuilder)

charTyped

open fun charTyped(chr: Char, modifiers: Int): Boolean

drawMessage

open fun drawMessage(context: DrawContext, textRenderer: TextRenderer, x: Int, y: Int, width: Int, height: Int, color: Int)

Draws the widgets message with standard edge padding and positioning.

forEachChild

open override fun forEachChild(consumer: Consumer<ClickableWidget>)

getBottom

open fun getBottom(): Int

getFocusedPath

@Nullable

open fun getFocusedPath(): GuiNavigationPath?

getHeight

open override fun getHeight(): Int

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationPath

@Nullable

open override fun getNavigationPath(navigation: GuiNavigation): GuiNavigationPath?

getRight

open fun getRight(): Int

getTooltip

@Nullable

open fun getTooltip(): Tooltip?

getType

open override fun getType(): Selectable.SelectionType

getWidth

open override fun getWidth(): Int

isHovered

open fun isHovered(): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

isNarratable

open override fun isNarratable(): Boolean

isSelected

open fun isSelected(): Boolean

keyReleased

open fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

mouseClicked

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseDragged

open override fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

mouseReleased

open override fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseScrolled

open fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

onPress

open override fun onPress()

Action invoked whenever the button is clicked on or activated with Enter.

onRelease

open fun onRelease(mouseX: Double, mouseY: Double)

playDownSound

open fun playDownSound(soundManager: SoundManager)

provideNarrationLines

open fun provideNarrationLines(): List<Text>

Provides a list of text for appending into a Narration Hint. By default this will use the same lines passed from provideTooltipLines, with predefined values for the inputs

provideTooltipLines

open fun provideTooltipLines(mouseX: Int, mouseY: Int, parentSelected: Boolean, keyboardFocused: Boolean): List<Text>

Provides a list of text lines for appending to a tooltip. Unlike appending in MC, the parent has final say on compiling the tooltip from the pieces given to it.

render

override fun render(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

renderBackground

open fun renderBackground(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, delta: Float)

Custom background rendering for the widget. By default, will render the standard MC button texture set.

renderCustom

open override fun renderCustom(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, delta: Float)

Custom foreground rendering for the widget. By default, will render the label.

setAlpha

open fun setAlpha(alpha: Float)

setDimensions

open fun setDimensions(width: Int, height: Int)

setDimensionsAndPosition

open fun setDimensionsAndPosition(width: Int, height: Int, x: Int, y: Int)

setHeight

open fun setHeight(height: Int)

setPosition

open fun setPosition(x: Int, y: Int)

setTooltip

open fun setTooltip(@Nullable tooltip: Tooltip?)

setTooltipDelay

open fun setTooltipDelay(tooltipDelay: Duration)

setWidth

open fun setWidth(width: Int)